home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr25 / isp3009b.zip / README1.DOC < prev    next >
Text File  |  1993-03-04  |  11KB  |  212 lines
  1. ==============================================================================
  2. readme1.doc      Ispell, International version 3.0.09(beta)            9/8/92
  3. ==============================================================================
  4.  
  5. This is port of the popular spelling program Ispell, international version
  6. 3.0.09(beta), written by Goeff Kuenning and Pace Willisson (with contributions
  7. from many others). 
  8.  
  9. This version is sort of a double beta version, as the version of Ispell which
  10. I have ported is a beta, and this is the first release of the OS/2 port.
  11.  
  12. Please read completely through this file and consult any other readme?.doc
  13. files in the distribution.
  14.  
  15. ***** THIS PORT OF ISPELL REQUIRES OS/2 2.0 *****
  16.  
  17. ***** INSTALLATION *****
  18. Basically, the installation consists of the following steps:
  19.         1) unpack the archive
  20.         2) move emx.dll and termcap.dat to suitable directories
  21.         3) set some environment variables for termcap
  22.         4) build the hashed dictionaries from the included word lists.
  23.         5) edit ispell.cfg and modify the settings for your system.
  24.  
  25. These steps are explained in detail below.
  26.  
  27. * Unpack the archive *
  28. If you are reading this document, you've succeeded at unpacking the archive.
  29. Ispell does not need to have its own directory, but you may find that to be
  30. more convenient. The archive contains no directory structure, so all the files
  31. will be unpacked to the current directory.  The files ispell.exe and
  32. ispell.cfg MUST remain in the same directory. The program determines the path
  33. of ispell.exe and looks for ispell.cfg in this directory.  You can rename
  34. ispell.exe, but you must also rename the base part of the configuration
  35. filename to match the base part to the executable filename. For example, if
  36. you rename ispell.exe to myspell.exe, you must also rename ispell.cfg to
  37. myspell.cfg.
  38.  
  39. * emx.dll *
  40. Ispell was ported using the emx/gcc environment. Therefore Ispell requires the
  41. file emx.dll, which is included in this distribution. Put emx.dll into a
  42. directory which is pointed to by the LIBPATH environment variable, or add the
  43. directory in which you choose to store emx.dll to LIBPATH.  If you already
  44. have a version of file emx.dll, try your existing emx.dll first. If problems
  45. arise, try the one included in this distribution.
  46.  
  47. * termcap.dat *
  48. Ispell uses termcap for performing terminal i/o. The file termcap.dat
  49. (included in this distribution) contains the terminal descriptions used by
  50. termcap. You may:
  51.         1) put termcap.dat in the "current" working directory
  52.         2) put termcap.dat in the directory \emx\etc on the "current" drive
  53.         3) put termcap.dat in a directory pointed to by the INIT or
  54.            EMXETC environment variables
  55.         4) Set the environment variable TERMCAP to point to the location of
  56.            termcap.dat.
  57.  
  58. I strongly recommend option 4.
  59.  
  60. You may also set the environment variable TERM to select one of the terminal
  61. types in termcap.dat. The terminal names are case sensitive, so type them
  62. exactly as they are found in termcap.dat when setting TERM. If TERM is not
  63. set, the terminal type defaults to 'ansi'. You can play around with the
  64. settings in termcap.dat to obtain the color combinations that suit you.  You
  65. must have the device driver ansi.sys loaded to use Ispell.  If you do not
  66. already have ansi.sys loaded, see the OS/2 online help for information on
  67. adding the device driver ansi.sys.  You must reboot your computer if you are
  68. adding ansi.sys
  69.  
  70. example: "SET TERM=ansi-color-2" selects the 'ansi-color-2' terminal type in
  71. termcap.dat
  72.  
  73. Currently, Ispell does not automatically detect screen size; you will have to
  74. set these values in the appropriate termcap.dat entry.
  75.  
  76. * ispell.cfg *
  77. Ispell was originally written for Unix systems, and the program has many
  78. compile-time options that are used to customize Ispell for the particular Unix
  79. system it is being installed on. These options are set by the system
  80. administrator before making the executable files. Since it is impossible 
  81. to know how users wish to install Ispell on their personal computers, I have
  82. added a configuration file that allows users to set some of the options that
  83. are "hard-wired" on Unix systems.
  84.  
  85. Ispell.cfg is a file that contains information about files that will be needed
  86. by Ispell during the spelling of documents. Currently, 3 keywords are valid in
  87. ispell.cfg (hopefully, I will be able to increase the configurability of
  88. Ispell and add more keywords).  The keywords are:
  89.  
  90.         ISDEFPDICT      Should contain the complete pathname of the 
  91.                         user's personal dictionary. This setting can be 
  92.                         overridden by the -p command line switch.
  93.  
  94.         ISDEFHASH       Should contain the pathname of the default hashed
  95.                         dictionary. This setting can be overridden by the -d
  96.                         command line switch.
  97.  
  98.         ISTEMPFILE      Should contain the pathname template for the temporary
  99.                         files.  The base filename must contain the characters
  100.                         'XXXXXX'.  Thus, if the temporary files are on a FAT
  101.                         drive, the base filename may contain only 2 additional
  102.                         characters.  'x:/ddddd/isXXXXXX.tmp' would be a valid
  103.                         FAT setting.  HPFS filenames may be longer.
  104.  
  105. The format for setting the keywords is:
  106. keyword=any_valid_filename   # optional comment 
  107.  
  108. The line, including comments, can be no longer than 240 characters.  The
  109. filename may contain drive specifiers as well as directories. YOU MUST USE
  110. FORWARD SLASHES (/) AS DIRECTORY SEPARATORS. Ispell.cfg may contain comments.
  111. Any text between a '#' and the end of line will be treated as a comment.
  112. Ispell will print out any invalid lines in ispell.cfg and abort. Please make
  113. sure all settings in ispell.cfg conform to your particular file system (FAT or
  114. HPFS). Currently, ispell.cfg is required.  If a configuration file is not
  115. found, Ispell will abort.
  116.  
  117. * hashed dictionaries *
  118. This port of ispell requires a main hashed dictionary and an optional
  119. personal word list. In order to use Ispell, you must create the main hashed
  120. dictionary from the raw word list and the affix file for the particular
  121. language you are using.  The hashed dictionary is much larger than the
  122. word list, but allows Ispell to work faster when spelling documents. Because
  123. the hashed dictionaries are very large, this distribution includes the
  124. word lists and a small program that creates the hashed dictionaries from the
  125. word lists and affix file.
  126.  
  127. Briefly, the main word list contains root words followed by flags which
  128. specify how and which suffixes and prefixes can be added to the word. The
  129. affix file gives the rules on how these flags are to be interpreted. To build
  130. a hashed dictionary for Ispell from the files included in this distribution,
  131. type:  
  132.  
  133.         x:> buildhas english.med english.aff engmed.hash 
  134. and/or 
  135.         x:> buildhas english.sml english.aff engsml.hash
  136. and/or 
  137.         x:> buildhas english.lrg english.aff englrg.hash
  138.  
  139. This will create the hashed dictionaries engmed.hash and/or engsml.hash and/or
  140. englrg.hash.  Assign the name of one of the dictionaries to the ISDEFHASH
  141. keyword in ispell.cfg. If you are on a FAT drive, you must name the output
  142. hashed dictionary appropriately, ie.  engmed.has. You can give the hashed
  143. dictionaries any names you wish. Remember to set ISDEFHASH so that it reflects
  144. the name of your hashed dictionary.
  145.  
  146. I have included three raw word lists:  english.sml, english.med, and
  147. english.lrg, along with the affix files english.aff and german.aff.
  148. English.lrg is known to contain errors, so beware.
  149.  
  150. The word lists english.sml, english.med and english.lrg are composed of
  151. several component word lists.  These component word lists contain the base
  152. word list as well as alternate American and British spellings. The component
  153. word lists are copied together and sorted into alphabetical order to form the
  154. main word list. The original Makefile is set up to automate this procedure on
  155. a Unix host, which is where I built the included word list . I have (will)
  156. also uploaded all the source code and component word list in another archive.
  157. If you wish to rebuild the main word lists, you can unpack the source code
  158. archive and look at the makefile to figure out how it is done. English.sml and
  159. english.med have undergone quite extensive testing.
  160.  
  161. I currently don't have any non-english word lists. There is a German affix
  162. file, german.aff, but that is all that comes with the original distribution.
  163.  
  164. * personal word lists*
  165. Ispell will automatically create a personal word list your under the name
  166. specified by the keyword ISDEFPDICT in ispell.cfg. Ispell creates a hash
  167. table for your personal dictionary during execution, so you do not need to
  168. create a hashed dictionary from your personal word list. You may edit the
  169. personal word list and add flags to the words if you wish. The flags are
  170. explained in english4.doc and ispell4.doc.
  171.  
  172. This should complete the installation of Ispell. If you have made any changes
  173. to config.sys, you should shutdown OS/2 and reboot your computer.
  174.  
  175.  
  176. ***** OTHER INFORMATION *****
  177.  
  178. * man pages *
  179. ASCII text versions of the Ispell Unix man pages are included. These man
  180. pages have been edited to reflect the changes made in this port of Ispell.
  181.  
  182. * FAT compatibility *
  183. Since Ispell is originally a Unix program, it can use filenames beyond the 8.3
  184. format allowed on an FAT systems. I have attempted to make this program FAT
  185. compatible. All hard-wired default filenames have been changed to be FAT
  186. compatible. 
  187.  
  188. * Ispell utilities *
  189. This is not a complete port of Ispell. The Unix shell scripts munchlist,
  190. findaffix, and tryaffix. Munchlist is a raw dictionary maintenance utility
  191. while findaffix and tryaffix are used for developing language affix files.
  192. According to the original author, these shell scripts are very taxing on
  193. system resources (mainly temporary file space) and require several Unix system
  194. utilities that OS/2 users may not have.  Also, the original author is
  195. considering converting these scripts to C at a later date.  For these reasons,
  196. I have decided not to port the shell scripts at this time.
  197.  
  198. * emacs support *
  199. The file ispell.el is included for emacs users. I don't use emacs so the emacs
  200. support hasn't been tested under OS/2.
  201.  
  202. * warranty *
  203. No warranty, express or implied is given for this software and documentation.
  204. No guarantee is made as to the proper functioning of this software. No
  205. liability will be admitted for any damage resulting from the use of any
  206. programs or files contained in this distribution.
  207.  
  208. * bugs *
  209. Send bug reports, errors in documentation, and suggestions to Joe Huber,
  210. jbhuber@iastate.edu. 
  211.  
  212.